home *** CD-ROM | disk | FTP | other *** search
/ X User Tools / X User Tools (O'Reilly and Associates)(1994).ISO / sun4c / archive / tcltk.z / tcltk / man / mann / focus.n < prev    next >
Text File  |  1994-09-20  |  10KB  |  320 lines
  1. '\"
  2. '\" Copyright (c) 1990-1992 The Regents of the University of California.
  3. '\" All rights reserved.
  4. '\"
  5. '\" Permission is hereby granted, without written agreement and without
  6. '\" license or royalty fees, to use, copy, modify, and distribute this
  7. '\" documentation for any purpose, provided that the above copyright
  8. '\" notice and the following two paragraphs appear in all copies.
  9. '\"
  10. '\" IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
  11. '\" FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  12. '\" ARISING OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF THE UNIVERSITY OF
  13. '\" CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  14. '\"
  15. '\" THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
  16. '\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
  17. '\" AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  18. '\" ON AN "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATION TO
  19. '\" PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  20. '\" 
  21. '\" $Header: /user6/ouster/wish/man/RCS/focus.n,v 1.9 93/04/01 09:52:39 ouster Exp $ SPRITE (Berkeley)
  22. '/" 
  23. .\" The definitions below are for supplemental macros used in Tcl/Tk
  24. .\" manual entries.
  25. .\"
  26. .\" .HS name section [date [version]]
  27. .\"    Replacement for .TH in other man pages.  See below for valid
  28. .\"    section names.
  29. .\"
  30. .\" .AP type name in/out [indent]
  31. .\"    Start paragraph describing an argument to a library procedure.
  32. .\"    type is type of argument (int, etc.), in/out is either "in", "out",
  33. .\"    or "in/out" to describe whether procedure reads or modifies arg,
  34. .\"    and indent is equivalent to second arg of .IP (shouldn't ever be
  35. .\"    needed;  use .AS below instead)
  36. .\"
  37. .\" .AS [type [name]]
  38. .\"    Give maximum sizes of arguments for setting tab stops.  Type and
  39. .\"    name are examples of largest possible arguments that will be passed
  40. .\"    to .AP later.  If args are omitted, default tab stops are used.
  41. .\"
  42. .\" .BS
  43. .\"    Start box enclosure.  From here until next .BE, everything will be
  44. .\"    enclosed in one large box.
  45. .\"
  46. .\" .BE
  47. .\"    End of box enclosure.
  48. .\"
  49. .\" .VS
  50. .\"    Begin vertical sidebar, for use in marking newly-changed parts
  51. .\"    of man pages.
  52. .\"
  53. .\" .VE
  54. .\"    End of vertical sidebar.
  55. .\"
  56. .\" .DS
  57. .\"    Begin an indented unfilled display.
  58. .\"
  59. .\" .DE
  60. .\"    End of indented unfilled display.
  61. .\"
  62. '\"    # Heading for Tcl/Tk man pages
  63. .de HS
  64. .ds ^3 \\0
  65. .if !"\\$3"" .ds ^3 \\$3
  66. .if '\\$2'cmds'       .TH \\$1 1 \\*(^3 \\$4
  67. .if '\\$2'lib'        .TH \\$1 3 \\*(^3 \\$4
  68. .if '\\$2'tcl'        .TH \\$1 n \\*(^3 Tcl "Tcl Built-In Commands"
  69. .if '\\$2'tk'         .TH \\$1 n \\*(^3 Tk "Tk Commands"
  70. .if '\\$2'tclc'        .TH \\$1 3 \\*(^3 Tcl "Tcl Library Procedures"
  71. .if '\\$2'tkc'         .TH \\$1 3 \\*(^3 Tk "Tk Library Procedures"
  72. .if '\\$2'tclcmds'         .TH \\$1 1 \\*(^3 Tk "Tcl Applications"
  73. .if '\\$2'tkcmds'         .TH \\$1 1 \\*(^3 Tk "Tk Applications"
  74. .if t .wh -1.3i ^B
  75. .nr ^l \\n(.l
  76. .ad b
  77. ..
  78. '\"    # Start an argument description
  79. .de AP
  80. .ie !"\\$4"" .TP \\$4
  81. .el \{\
  82. .   ie !"\\$2"" .TP \\n()Cu
  83. .   el          .TP 15
  84. .\}
  85. .ie !"\\$3"" \{\
  86. .ta \\n()Au \\n()Bu
  87. \&\\$1    \\fI\\$2\\fP    (\\$3)
  88. .\".b
  89. .\}
  90. .el \{\
  91. .br
  92. .ie !"\\$2"" \{\
  93. \&\\$1    \\fI\\$2\\fP
  94. .\}
  95. .el \{\
  96. \&\\fI\\$1\\fP
  97. .\}
  98. .\}
  99. ..
  100. '\"    # define tabbing values for .AP
  101. .de AS
  102. .nr )A 10n
  103. .if !"\\$1"" .nr )A \\w'\\$1'u+3n
  104. .nr )B \\n()Au+15n
  105. .\"
  106. .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
  107. .nr )C \\n()Bu+\\w'(in/out)'u+2n
  108. ..
  109. '\"    # BS - start boxed text
  110. '\"    # ^y = starting y location
  111. '\"    # ^b = 1
  112. .de BS
  113. .br
  114. .mk ^y
  115. .nr ^b 1u
  116. .if n .nf
  117. .if n .ti 0
  118. .if n \l'\\n(.lu\(ul'
  119. .if n .fi
  120. ..
  121. '\"    # BE - end boxed text (draw box now)
  122. .de BE
  123. .nf
  124. .ti 0
  125. .mk ^t
  126. .ie n \l'\\n(^lu\(ul'
  127. .el \{\
  128. .\"    Draw four-sided box normally, but don't draw top of
  129. .\"    box if the box started on an earlier page.
  130. .ie !\\n(^b-1 \{\
  131. \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  132. .\}
  133. .el \}\
  134. \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  135. .\}
  136. .\}
  137. .fi
  138. .br
  139. .nr ^b 0
  140. ..
  141. '\"    # VS - start vertical sidebar
  142. '\"    # ^Y = starting y location
  143. '\"    # ^v = 1 (for troff;  for nroff this doesn't matter)
  144. .de VS
  145. .mk ^Y
  146. .ie n 'mc \s12\(br\s0
  147. .el .nr ^v 1u
  148. ..
  149. '\"    # VE - end of vertical sidebar
  150. .de VE
  151. .ie n 'mc
  152. .el \{\
  153. .ev 2
  154. .nf
  155. .ti 0
  156. .mk ^t
  157. \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
  158. .sp -1
  159. .fi
  160. .ev
  161. .\}
  162. .nr ^v 0
  163. ..
  164. '\"    # Special macro to handle page bottom:  finish off current
  165. '\"    # box/sidebar if in box/sidebar mode, then invoked standard
  166. '\"    # page bottom macro.
  167. .de ^B
  168. .ev 2
  169. 'ti 0
  170. 'nf
  171. .mk ^t
  172. .if \\n(^b \{\
  173. .\"    Draw three-sided box if this is the box's first page,
  174. .\"    draw two sides but no top otherwise.
  175. .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
  176. .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
  177. .\}
  178. .if \\n(^v \{\
  179. .nr ^x \\n(^tu+1v-\\n(^Yu
  180. \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
  181. .\}
  182. .bp
  183. 'fi
  184. .ev
  185. .if \\n(^b \{\
  186. .mk ^y
  187. .nr ^b 2
  188. .\}
  189. .if \\n(^v \{\
  190. .mk ^Y
  191. .\}
  192. ..
  193. '\"    # DS - begin display
  194. .de DS
  195. .RS
  196. .nf
  197. .sp
  198. ..
  199. '\"    # DE - end display
  200. .de DE
  201. .fi
  202. .RE
  203. .sp .5
  204. ..
  205. .HS focus tk
  206. .BS
  207. '\" Note:  do not modify the .SH NAME line immediately below!
  208. .SH NAME
  209. focus \- Direct keyboard events to a particular window
  210. .SH SYNOPSIS
  211. \fBfocus\fR
  212. .br
  213. \fBfocus \fIwindow\fR
  214. .br
  215. \fBfocus \fIoption\fR ?\fIarg arg ...\fR?
  216. .BE
  217.  
  218. .SH DESCRIPTION
  219. .PP
  220. .VS
  221. The \fBfocus\fR command is used to manage the Tk input focus.
  222. At any given time, one window in an application is designated as
  223. the focus window for that application;  any key press or key release
  224. events directed to any window in the application will be redirected
  225. instead to the focus window.  If there is no focus window for an
  226. application then keyboard events are discarded.
  227. Typically, windows that are prepared to deal with the focus
  228. (e.g. entries and other widgets that display editable text) will
  229. claim the focus when mouse button 1 is pressed in them.
  230. When an application is created its main window is initially given
  231. the focus.
  232. .PP
  233. The \fBfocus\fR command can take any of the following forms:
  234. .TP
  235. \fBfocus\fR
  236. If invoked with no arguments, \fBfocus\fR returns the path name of
  237. the current focus window, or \fBnone\fR if there is no focus window.
  238. .TP
  239. \fBfocus \fIwindow\fR
  240. If invoked with a single argument consisting of a window's path
  241. name, \fBfocus\fR sets the input focus to that window.
  242. The return value is an empty string.
  243. .TP
  244. \fBfocus default \fR?\fIwindow\fR?
  245. If \fIwindow\fR is specified, it becomes the default focus window
  246. (the window that receives the focus whenever the focus window is
  247. deleted) and the command returns an empty string.
  248. If \fIwindow\fR isn't specified, the command returns the path name
  249. of the current default focus window, or \fBnone\fR if there is no
  250. default.
  251. \fIWindow\fR may be specified as \fBnone\fR to clear its existing
  252. value.
  253. The default window is initially \fBnone\fR.
  254. .TP
  255. \fBfocus none\fR
  256. Clears the focus window, so that keyboard input to this application
  257. will be discarded.
  258.  
  259. .SH "FOCUS EVENTS"
  260. .PP
  261. Tk's model of the input focus is different than X's model, and the
  262. focus window set with the \fBfocus\fR command is not usually the
  263. same as the X focus window.
  264. Tk never explicitly changes the official X focus window.
  265. It waits for the window manager to direct the X input focus to
  266. and from the application's top-level windows, and it intercepts
  267. \fBFocusIn\fR and \fBFocusOut\fR events coming from the X
  268. server to detect these changes.
  269. All of the focus events received from X are discarded by Tk;  they
  270. never reach the application.
  271. Instead, Tk generates a different stream of \fBFocusIn\fR and
  272. \fBFocusOut\fR for the application.
  273. This means that \fBFocusIn\fR and
  274. and \fBFocusOut\fR events seen by the application will not obey the
  275. conventions described in the documentation for Xlib.
  276. .PP
  277. Tk applications receive two kinds of \fBFocusIn\fR and \fBFocusOut\fR
  278. events, which can be distinguished by their \fIdetail\fR fields.
  279. Events with a \fIdetail\fR of \fBNotifyAncestor\fR are directed
  280. to the current focus window when it becomes active or inactive.
  281. A window is the active focus whenever two conditions are
  282. simultaneously true: (a) the window is the focus window for its
  283. application, and (b) some top-level window in the application has
  284. received the X focus.
  285. When this happens Tk generates a \fBFocusIn\fR event for the focus
  286. window with detail \fBNotifyAncestor\fR.
  287. When a window loses the active focus (either because the window manager
  288. removed the focus from the application or because the focus window changed
  289. within the application) then it receives a \fBFocusOut\fR event
  290. with detail \fBNotifyAncestor\fR.
  291. .PP
  292. The events described above are directed to the application's focus
  293. window regardless of which top-level window within the application
  294. has received the focus.
  295. The second kind of focus event is provided for applications that
  296. need to know which particular top-level window has the X focus.
  297. Tk generates \fBFocusIn\fR and \fBFocusOut\fR events with detail
  298. \fBNotifyVirtual\fR for top-level windows whenever they receive or
  299. lose the X focus.
  300. These events are generated regardless of which window in the
  301. application has the Tk input focus.
  302. They do not imply that keystrokes will be directed to the window
  303. that receives the event;  they simply indicate which top-level
  304. window is active as far as the window manager is concerned.
  305. If a top-level window is also the application's focus window,
  306. then it will receive both \fBNotifyVirtual\fR and \fBNotifyAncestor\fR
  307. events when it receives or loses the X focus.
  308. .PP
  309. Tk does not generate the hierarchical chains of \fBFocusIn\fR and
  310. \fBFocusOut\fR events described in the Xlib documentation (e.g.
  311. a window can get a \fBFocusIn\fR or \fBFocusOut\fR event without
  312. all of its ancestors getting events too).
  313. Furthermore, the \fImode\fR field in focus events is always
  314. \fBNotifyNormal\fR and the only values ever present in the
  315. \fIdetail\fR field are \fBNotifyAncestor\fR and \fBNotifyVirtual\fR.
  316. .VE
  317.  
  318. .SH KEYWORDS
  319. events, focus, keyboard, top-level, window manager
  320.